<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.11"/>
<title>OrbbecSDK: ob::FrameSet Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
  $(document).ready(function() { init_search(); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><img alt="Logo" src="orbbec_icon.png"/></td>
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">OrbbecSDK
   &#160;<span id="projectnumber">1.8.3</span>
   </div>
   <div id="projectbrief">OrbbecSDK: Software-Development-Kit for Orbbec 3D Cameras</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.11 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
      <li><a href="namespaces.html"><span>Namespaces</span></a></li>
      <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
      <li><a href="files.html"><span>Files</span></a></li>
      <li>
        <div id="MSearchBox" class="MSearchBoxInactive">
        <span class="left">
          <img id="MSearchSelect" src="search/mag_sel.png"
               onmouseover="return searchBox.OnSearchSelectShow()"
               onmouseout="return searchBox.OnSearchSelectHide()"
               alt=""/>
          <input type="text" id="MSearchField" value="Search" accesskey="S"
               onfocus="searchBox.OnSearchFieldFocus(true)" 
               onblur="searchBox.OnSearchFieldFocus(false)" 
               onkeyup="searchBox.OnSearchFieldChange(event)"/>
          </span><span class="right">
            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
          </span>
        </div>
      </li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
      <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
      <li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
    </ul>
  </div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div id="nav-path" class="navpath">
  <ul>
<li class="navelem"><a class="el" href="namespaceob.html">ob</a></li><li class="navelem"><a class="el" href="classob_1_1FrameSet.html">FrameSet</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#friends">Friends</a> &#124;
<a href="classob_1_1FrameSet-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">ob::FrameSet Class Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p>Define the <a class="el" href="classob_1_1FrameSet.html" title="Define the FrameSet class, which inherits from the Frame class. ">FrameSet</a> class, which inherits from the <a class="el" href="classob_1_1Frame.html">Frame</a> class.  
 <a href="classob_1_1FrameSet.html#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="Frame_8hpp_source.html">Frame.hpp</a>&gt;</code></p>
<div id="dynsection-0" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
  <img id="dynsection-0-trigger" src="closed.png" alt="+"/> Inheritance diagram for ob::FrameSet:</div>
<div id="dynsection-0-summary" class="dynsummary" style="display:block;">
</div>
<div id="dynsection-0-content" class="dyncontent" style="display:none;">
 <div class="center">
  <img src="classob_1_1FrameSet.png" usemap="#ob::FrameSet_map" alt=""/>
  <map id="ob::FrameSet_map" name="ob::FrameSet_map">
<area href="classob_1_1Frame.html" alt="ob::Frame" shape="rect" coords="0,56,236,80"/>
</map>
 </div></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:ade0d0e0b738e298c8990adcdbcf4ca60"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classob_1_1FrameSet.html#ade0d0e0b738e298c8990adcdbcf4ca60">FrameSet</a> (std::unique_ptr&lt; FrameImpl &gt; impl)</td></tr>
<tr class="separator:ade0d0e0b738e298c8990adcdbcf4ca60"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a98ad7aba82289d48d2846b20fc573cba"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classob_1_1FrameSet.html#a98ad7aba82289d48d2846b20fc573cba">FrameSet</a> (<a class="el" href="classob_1_1Frame.html">Frame</a> &amp;frame)</td></tr>
<tr class="separator:a98ad7aba82289d48d2846b20fc573cba"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a686ada4f118193534e0bc586693237b9"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classob_1_1FrameSet.html#a686ada4f118193534e0bc586693237b9">~FrameSet</a> () noexceptoverride</td></tr>
<tr class="separator:a686ada4f118193534e0bc586693237b9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab492b8616d7a13fa17c4b53b43ad3374"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classob_1_1FrameSet.html#ab492b8616d7a13fa17c4b53b43ad3374">frameCount</a> ()</td></tr>
<tr class="memdesc:ab492b8616d7a13fa17c4b53b43ad3374"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the number of frames in the <a class="el" href="classob_1_1FrameSet.html" title="Define the FrameSet class, which inherits from the Frame class. ">FrameSet</a>.  <a href="#ab492b8616d7a13fa17c4b53b43ad3374">More...</a><br /></td></tr>
<tr class="separator:ab492b8616d7a13fa17c4b53b43ad3374"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5c7d2bdc96cb417a5d45579696b6df4d"><td class="memItemLeft" align="right" valign="top">std::shared_ptr&lt; <a class="el" href="classob_1_1DepthFrame.html">DepthFrame</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classob_1_1FrameSet.html#a5c7d2bdc96cb417a5d45579696b6df4d">depthFrame</a> ()</td></tr>
<tr class="memdesc:a5c7d2bdc96cb417a5d45579696b6df4d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the depth frame in the <a class="el" href="classob_1_1FrameSet.html" title="Define the FrameSet class, which inherits from the Frame class. ">FrameSet</a>.  <a href="#a5c7d2bdc96cb417a5d45579696b6df4d">More...</a><br /></td></tr>
<tr class="separator:a5c7d2bdc96cb417a5d45579696b6df4d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac8bf02c82360d193704d17c1dc266e1b"><td class="memItemLeft" align="right" valign="top">std::shared_ptr&lt; <a class="el" href="classob_1_1ColorFrame.html">ColorFrame</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classob_1_1FrameSet.html#ac8bf02c82360d193704d17c1dc266e1b">colorFrame</a> ()</td></tr>
<tr class="memdesc:ac8bf02c82360d193704d17c1dc266e1b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the color frame in the <a class="el" href="classob_1_1FrameSet.html" title="Define the FrameSet class, which inherits from the Frame class. ">FrameSet</a>.  <a href="#ac8bf02c82360d193704d17c1dc266e1b">More...</a><br /></td></tr>
<tr class="separator:ac8bf02c82360d193704d17c1dc266e1b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abc6ba365ed4fb93721863b6f65c03c17"><td class="memItemLeft" align="right" valign="top">std::shared_ptr&lt; <a class="el" href="classob_1_1IRFrame.html">IRFrame</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classob_1_1FrameSet.html#abc6ba365ed4fb93721863b6f65c03c17">irFrame</a> ()</td></tr>
<tr class="memdesc:abc6ba365ed4fb93721863b6f65c03c17"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the infrared frame in the <a class="el" href="classob_1_1FrameSet.html" title="Define the FrameSet class, which inherits from the Frame class. ">FrameSet</a>.  <a href="#abc6ba365ed4fb93721863b6f65c03c17">More...</a><br /></td></tr>
<tr class="separator:abc6ba365ed4fb93721863b6f65c03c17"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac505b33599d2cae882d913e1d60eb4a8"><td class="memItemLeft" align="right" valign="top">std::shared_ptr&lt; <a class="el" href="classob_1_1PointsFrame.html">PointsFrame</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classob_1_1FrameSet.html#ac505b33599d2cae882d913e1d60eb4a8">pointsFrame</a> ()</td></tr>
<tr class="memdesc:ac505b33599d2cae882d913e1d60eb4a8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the point cloud frame in the <a class="el" href="classob_1_1FrameSet.html" title="Define the FrameSet class, which inherits from the Frame class. ">FrameSet</a>.  <a href="#ac505b33599d2cae882d913e1d60eb4a8">More...</a><br /></td></tr>
<tr class="separator:ac505b33599d2cae882d913e1d60eb4a8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad11bfa51a7b0ba4637761d2116b30c71"><td class="memItemLeft" align="right" valign="top">std::shared_ptr&lt; <a class="el" href="classob_1_1Frame.html">Frame</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classob_1_1FrameSet.html#ad11bfa51a7b0ba4637761d2116b30c71">getFrame</a> (<a class="el" href="ObTypes_8h.html#a42b4219d92627d3cf51af225ec58a345">OBFrameType</a> frameType)</td></tr>
<tr class="memdesc:ad11bfa51a7b0ba4637761d2116b30c71"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get a frame of a specific type from the <a class="el" href="classob_1_1FrameSet.html" title="Define the FrameSet class, which inherits from the Frame class. ">FrameSet</a>.  <a href="#ad11bfa51a7b0ba4637761d2116b30c71">More...</a><br /></td></tr>
<tr class="separator:ad11bfa51a7b0ba4637761d2116b30c71"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac89b6e05b5ad406b2ed57294cf5b363b"><td class="memItemLeft" align="right" valign="top">std::shared_ptr&lt; <a class="el" href="classob_1_1Frame.html">Frame</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classob_1_1FrameSet.html#ac89b6e05b5ad406b2ed57294cf5b363b">getFrame</a> (int <a class="el" href="classob_1_1Frame.html#a1001bd44f6b2a2eb0b4c4b7bb0f317f1">index</a>)</td></tr>
<tr class="memdesc:ac89b6e05b5ad406b2ed57294cf5b363b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get a frame at a specific index from the <a class="el" href="classob_1_1FrameSet.html" title="Define the FrameSet class, which inherits from the Frame class. ">FrameSet</a>.  <a href="#ac89b6e05b5ad406b2ed57294cf5b363b">More...</a><br /></td></tr>
<tr class="separator:ac89b6e05b5ad406b2ed57294cf5b363b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_classob_1_1Frame"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classob_1_1Frame')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classob_1_1Frame.html">ob::Frame</a></td></tr>
<tr class="memitem:a78bdb1b88fcbeee6cd51592e72512a41 inherit pub_methods_classob_1_1Frame"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classob_1_1Frame.html#a78bdb1b88fcbeee6cd51592e72512a41">Frame</a> (std::unique_ptr&lt; FrameImpl &gt; impl)</td></tr>
<tr class="separator:a78bdb1b88fcbeee6cd51592e72512a41 inherit pub_methods_classob_1_1Frame"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0cb761a3a0a58bf2664a990ccf868e5b inherit pub_methods_classob_1_1Frame"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classob_1_1Frame.html#a0cb761a3a0a58bf2664a990ccf868e5b">Frame</a> (<a class="el" href="classob_1_1Frame.html">Frame</a> &amp;frame)</td></tr>
<tr class="separator:a0cb761a3a0a58bf2664a990ccf868e5b inherit pub_methods_classob_1_1Frame"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0773e0d3139e8f66521b2fbeb69c3dd3 inherit pub_methods_classob_1_1Frame"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classob_1_1Frame.html#a0773e0d3139e8f66521b2fbeb69c3dd3">~Frame</a> () noexcept</td></tr>
<tr class="separator:a0773e0d3139e8f66521b2fbeb69c3dd3 inherit pub_methods_classob_1_1Frame"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a34fba5e4839efa8fd8a6acec47df9637 inherit pub_methods_classob_1_1Frame"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="ObTypes_8h.html#a42b4219d92627d3cf51af225ec58a345">OBFrameType</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classob_1_1Frame.html#a34fba5e4839efa8fd8a6acec47df9637">type</a> ()</td></tr>
<tr class="memdesc:a34fba5e4839efa8fd8a6acec47df9637 inherit pub_methods_classob_1_1Frame"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the type of frame.  <a href="#a34fba5e4839efa8fd8a6acec47df9637">More...</a><br /></td></tr>
<tr class="separator:a34fba5e4839efa8fd8a6acec47df9637 inherit pub_methods_classob_1_1Frame"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac3de67739f93b5767c8fe952559b74db inherit pub_methods_classob_1_1Frame"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="ObTypes_8h.html#a30904eab1a667b797e7ce1099ba7c36a">OBFormat</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classob_1_1Frame.html#ac3de67739f93b5767c8fe952559b74db">format</a> ()</td></tr>
<tr class="memdesc:ac3de67739f93b5767c8fe952559b74db inherit pub_methods_classob_1_1Frame"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the format of the frame.  <a href="#ac3de67739f93b5767c8fe952559b74db">More...</a><br /></td></tr>
<tr class="separator:ac3de67739f93b5767c8fe952559b74db inherit pub_methods_classob_1_1Frame"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1001bd44f6b2a2eb0b4c4b7bb0f317f1 inherit pub_methods_classob_1_1Frame"><td class="memItemLeft" align="right" valign="top">virtual uint64_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classob_1_1Frame.html#a1001bd44f6b2a2eb0b4c4b7bb0f317f1">index</a> ()</td></tr>
<tr class="memdesc:a1001bd44f6b2a2eb0b4c4b7bb0f317f1 inherit pub_methods_classob_1_1Frame"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the sequence number of the frame.  <a href="#a1001bd44f6b2a2eb0b4c4b7bb0f317f1">More...</a><br /></td></tr>
<tr class="separator:a1001bd44f6b2a2eb0b4c4b7bb0f317f1 inherit pub_methods_classob_1_1Frame"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ade0133122510f1081a2f9754fe3113cb inherit pub_methods_classob_1_1Frame"><td class="memItemLeft" align="right" valign="top">virtual void *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classob_1_1Frame.html#ade0133122510f1081a2f9754fe3113cb">data</a> ()</td></tr>
<tr class="memdesc:ade0133122510f1081a2f9754fe3113cb inherit pub_methods_classob_1_1Frame"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the frame data.  <a href="#ade0133122510f1081a2f9754fe3113cb">More...</a><br /></td></tr>
<tr class="separator:ade0133122510f1081a2f9754fe3113cb inherit pub_methods_classob_1_1Frame"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a15aa7ffde185af68c920e17aaf0b9131 inherit pub_methods_classob_1_1Frame"><td class="memItemLeft" align="right" valign="top">virtual uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classob_1_1Frame.html#a15aa7ffde185af68c920e17aaf0b9131">dataSize</a> ()</td></tr>
<tr class="memdesc:a15aa7ffde185af68c920e17aaf0b9131 inherit pub_methods_classob_1_1Frame"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the size of the frame data.  <a href="#a15aa7ffde185af68c920e17aaf0b9131">More...</a><br /></td></tr>
<tr class="separator:a15aa7ffde185af68c920e17aaf0b9131 inherit pub_methods_classob_1_1Frame"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae7df5f8bfe70a3a3e8543e24a04f85bc inherit pub_methods_classob_1_1Frame"><td class="memItemLeft" align="right" valign="top">uint64_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classob_1_1Frame.html#ae7df5f8bfe70a3a3e8543e24a04f85bc">timeStamp</a> ()</td></tr>
<tr class="memdesc:ae7df5f8bfe70a3a3e8543e24a04f85bc inherit pub_methods_classob_1_1Frame"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the hardware timestamp of the frame in milliseconds.  <a href="#ae7df5f8bfe70a3a3e8543e24a04f85bc">More...</a><br /></td></tr>
<tr class="separator:ae7df5f8bfe70a3a3e8543e24a04f85bc inherit pub_methods_classob_1_1Frame"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aebc0c3fb0c2c3d68519258abe4394908 inherit pub_methods_classob_1_1Frame"><td class="memItemLeft" align="right" valign="top">uint64_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classob_1_1Frame.html#aebc0c3fb0c2c3d68519258abe4394908">timeStampUs</a> ()</td></tr>
<tr class="memdesc:aebc0c3fb0c2c3d68519258abe4394908 inherit pub_methods_classob_1_1Frame"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the hardware timestamp of the frame in microseconds.  <a href="#aebc0c3fb0c2c3d68519258abe4394908">More...</a><br /></td></tr>
<tr class="separator:aebc0c3fb0c2c3d68519258abe4394908 inherit pub_methods_classob_1_1Frame"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0950bcb7600016f3f9d71ed82d9257a6 inherit pub_methods_classob_1_1Frame"><td class="memItemLeft" align="right" valign="top">uint64_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classob_1_1Frame.html#a0950bcb7600016f3f9d71ed82d9257a6">systemTimeStamp</a> ()</td></tr>
<tr class="memdesc:a0950bcb7600016f3f9d71ed82d9257a6 inherit pub_methods_classob_1_1Frame"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the system timestamp of the frame in milliseconds.  <a href="#a0950bcb7600016f3f9d71ed82d9257a6">More...</a><br /></td></tr>
<tr class="separator:a0950bcb7600016f3f9d71ed82d9257a6 inherit pub_methods_classob_1_1Frame"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae6ce510d6e741d3f46ec34d475074b6f inherit pub_methods_classob_1_1Frame"><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
<tr class="memitem:ae6ce510d6e741d3f46ec34d475074b6f inherit pub_methods_classob_1_1Frame"><td class="memTemplItemLeft" align="right" valign="top">bool&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classob_1_1Frame.html#ae6ce510d6e741d3f46ec34d475074b6f">is</a> ()</td></tr>
<tr class="memdesc:ae6ce510d6e741d3f46ec34d475074b6f inherit pub_methods_classob_1_1Frame"><td class="mdescLeft">&#160;</td><td class="mdescRight">Check if the runtime type of the frame object is compatible with a given type.  <a href="#ae6ce510d6e741d3f46ec34d475074b6f">More...</a><br /></td></tr>
<tr class="separator:ae6ce510d6e741d3f46ec34d475074b6f inherit pub_methods_classob_1_1Frame"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad469213f43249aabce4b96d746527a62 inherit pub_methods_classob_1_1Frame"><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
<tr class="memitem:ad469213f43249aabce4b96d746527a62 inherit pub_methods_classob_1_1Frame"><td class="memTemplItemLeft" align="right" valign="top">std::shared_ptr&lt; T &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classob_1_1Frame.html#ad469213f43249aabce4b96d746527a62">as</a> ()</td></tr>
<tr class="memdesc:ad469213f43249aabce4b96d746527a62 inherit pub_methods_classob_1_1Frame"><td class="mdescLeft">&#160;</td><td class="mdescRight">Convert the frame object to a target type.  <a href="#ad469213f43249aabce4b96d746527a62">More...</a><br /></td></tr>
<tr class="separator:ad469213f43249aabce4b96d746527a62 inherit pub_methods_classob_1_1Frame"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="friends"></a>
Friends</h2></td></tr>
<tr class="memitem:af9f0f1adbd5baee7830839447205af8d"><td class="memItemLeft" align="right" valign="top">class&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classob_1_1FrameSet.html#af9f0f1adbd5baee7830839447205af8d">Pipeline</a></td></tr>
<tr class="separator:af9f0f1adbd5baee7830839447205af8d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a34f7bc7cd29643e53d23b7d500d21739"><td class="memItemLeft" align="right" valign="top">class&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classob_1_1FrameSet.html#a34f7bc7cd29643e53d23b7d500d21739">Filter</a></td></tr>
<tr class="separator:a34f7bc7cd29643e53d23b7d500d21739"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="inherited"></a>
Additional Inherited Members</h2></td></tr>
<tr class="inherit_header pro_attribs_classob_1_1Frame"><td colspan="2" onclick="javascript:toggleInherit('pro_attribs_classob_1_1Frame')"><img src="closed.png" alt="-"/>&#160;Protected Attributes inherited from <a class="el" href="classob_1_1Frame.html">ob::Frame</a></td></tr>
<tr class="memitem:a2683616ec8b3346cf9412051779b9721 inherit pro_attribs_classob_1_1Frame"><td class="memItemLeft" align="right" valign="top">std::unique_ptr&lt; FrameImpl &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classob_1_1Frame.html#a2683616ec8b3346cf9412051779b9721">impl_</a></td></tr>
<tr class="separator:a2683616ec8b3346cf9412051779b9721 inherit pro_attribs_classob_1_1Frame"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Define the <a class="el" href="classob_1_1FrameSet.html" title="Define the FrameSet class, which inherits from the Frame class. ">FrameSet</a> class, which inherits from the <a class="el" href="classob_1_1Frame.html">Frame</a> class. </p>

<p>Definition at line <a class="el" href="Frame_8hpp_source.html#l00245">245</a> of file <a class="el" href="Frame_8hpp_source.html">Frame.hpp</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="ade0d0e0b738e298c8990adcdbcf4ca60"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">ob::FrameSet::FrameSet </td>
          <td>(</td>
          <td class="paramtype">std::unique_ptr&lt; FrameImpl &gt;&#160;</td>
          <td class="paramname"><em>impl</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">explicit</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

</div>
</div>
<a class="anchor" id="a98ad7aba82289d48d2846b20fc573cba"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">ob::FrameSet::FrameSet </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="classob_1_1Frame.html">Frame</a> &amp;&#160;</td>
          <td class="paramname"><em>frame</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">explicit</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

</div>
</div>
<a class="anchor" id="a686ada4f118193534e0bc586693237b9"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">ob::FrameSet::~FrameSet </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">noexcept</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="ab492b8616d7a13fa17c4b53b43ad3374"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">uint32_t ob::FrameSet::frameCount </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Get the number of frames in the <a class="el" href="classob_1_1FrameSet.html" title="Define the FrameSet class, which inherits from the Frame class. ">FrameSet</a>. </p>
<dl class="section return"><dt>Returns</dt><dd>uint32_t The number of frames </dd></dl>

</div>
</div>
<a class="anchor" id="a5c7d2bdc96cb417a5d45579696b6df4d"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">std::shared_ptr&lt;<a class="el" href="classob_1_1DepthFrame.html">DepthFrame</a>&gt; ob::FrameSet::depthFrame </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Get the depth frame in the <a class="el" href="classob_1_1FrameSet.html" title="Define the FrameSet class, which inherits from the Frame class. ">FrameSet</a>. </p>
<dl class="section return"><dt>Returns</dt><dd>std::shared_ptr&lt;DepthFrame&gt; The depth frame </dd></dl>

</div>
</div>
<a class="anchor" id="ac8bf02c82360d193704d17c1dc266e1b"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">std::shared_ptr&lt;<a class="el" href="classob_1_1ColorFrame.html">ColorFrame</a>&gt; ob::FrameSet::colorFrame </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Get the color frame in the <a class="el" href="classob_1_1FrameSet.html" title="Define the FrameSet class, which inherits from the Frame class. ">FrameSet</a>. </p>
<dl class="section return"><dt>Returns</dt><dd>std::shared_ptr&lt;ColorFrame&gt; The color frame </dd></dl>

</div>
</div>
<a class="anchor" id="abc6ba365ed4fb93721863b6f65c03c17"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">std::shared_ptr&lt;<a class="el" href="classob_1_1IRFrame.html">IRFrame</a>&gt; ob::FrameSet::irFrame </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Get the infrared frame in the <a class="el" href="classob_1_1FrameSet.html" title="Define the FrameSet class, which inherits from the Frame class. ">FrameSet</a>. </p>
<dl class="section return"><dt>Returns</dt><dd>std::shared_ptr&lt;IRFrame&gt; The infrared frame </dd></dl>

</div>
</div>
<a class="anchor" id="ac505b33599d2cae882d913e1d60eb4a8"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">std::shared_ptr&lt;<a class="el" href="classob_1_1PointsFrame.html">PointsFrame</a>&gt; ob::FrameSet::pointsFrame </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Get the point cloud frame in the <a class="el" href="classob_1_1FrameSet.html" title="Define the FrameSet class, which inherits from the Frame class. ">FrameSet</a>. </p>
<dl class="section return"><dt>Returns</dt><dd>std::shared_ptr&lt;PointsFrame&gt; The point cloud data frame </dd></dl>

</div>
</div>
<a class="anchor" id="ad11bfa51a7b0ba4637761d2116b30c71"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">std::shared_ptr&lt;<a class="el" href="classob_1_1Frame.html">Frame</a>&gt; ob::FrameSet::getFrame </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="ObTypes_8h.html#a42b4219d92627d3cf51af225ec58a345">OBFrameType</a>&#160;</td>
          <td class="paramname"><em>frameType</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Get a frame of a specific type from the <a class="el" href="classob_1_1FrameSet.html" title="Define the FrameSet class, which inherits from the Frame class. ">FrameSet</a>. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">frameType</td><td>The type of sensor </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>std::shared_ptr&lt;Frame&gt; The corresponding type of frame </dd></dl>

</div>
</div>
<a class="anchor" id="ac89b6e05b5ad406b2ed57294cf5b363b"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">std::shared_ptr&lt;<a class="el" href="classob_1_1Frame.html">Frame</a>&gt; ob::FrameSet::getFrame </td>
          <td>(</td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>index</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Get a frame at a specific index from the <a class="el" href="classob_1_1FrameSet.html" title="Define the FrameSet class, which inherits from the Frame class. ">FrameSet</a>. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">index</td><td>The index of the frame </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>std::shared_ptr&lt;Frame&gt; The frame at the specified index </dd></dl>

</div>
</div>
<h2 class="groupheader">Friends And Related Function Documentation</h2>
<a class="anchor" id="af9f0f1adbd5baee7830839447205af8d"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">friend class <a class="el" href="classob_1_1Pipeline.html">Pipeline</a></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">friend</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Definition at line <a class="el" href="Frame_8hpp_source.html#l00306">306</a> of file <a class="el" href="Frame_8hpp_source.html">Frame.hpp</a>.</p>

</div>
</div>
<a class="anchor" id="a34f7bc7cd29643e53d23b7d500d21739"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">friend class <a class="el" href="classob_1_1Filter.html">Filter</a></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">friend</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Definition at line <a class="el" href="Frame_8hpp_source.html#l00307">307</a> of file <a class="el" href="Frame_8hpp_source.html">Frame.hpp</a>.</p>

</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>/root/libobsensor/include/libobsensor/hpp/<a class="el" href="Frame_8hpp_source.html">Frame.hpp</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Fri Nov 24 2023 10:56:17 for OrbbecSDK by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.11
</small></address>
</body>
</html>
